fix(cli): prefer x-fern-server-name over description in multi-api environment grouping #17314
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,376 @@ | ||
| { | ||
| "specVersion": "1.0.0", | ||
| "title": "Core API", | ||
| "servers": [ | ||
| { | ||
| "type": "grouped", | ||
| "name": "Production", | ||
| "description": "Production environment", | ||
| "urls": { | ||
| "api": { | ||
| "url": "https://api.example.com" | ||
| }, | ||
| "auth": { | ||
| "url": "https://auth.example.com" | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "type": "grouped", | ||
| "name": "Staging", | ||
| "description": "Staging environment", | ||
| "urls": { | ||
| "api": { | ||
| "url": "https://api.stage.example.com" | ||
| }, | ||
| "auth": { | ||
| "url": "https://auth.stage.example.com" | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "type": "grouped", | ||
| "name": "Development", | ||
| "description": "Development environment", | ||
| "urls": { | ||
| "api": { | ||
| "url": "https://api.dev.example.com" | ||
| }, | ||
| "auth": { | ||
| "url": "https://auth.dev.example.com" | ||
| } | ||
| } | ||
| } | ||
| ], | ||
| "websocketServers": [], | ||
| "tags": { | ||
| "tagsById": {} | ||
| }, | ||
| "hasEndpointsMarkedInternal": false, | ||
| "endpoints": [ | ||
| { | ||
| "summary": "List widgets", | ||
| "audiences": [], | ||
| "operationId": "listWidgets", | ||
| "tags": [], | ||
| "pathParameters": [], | ||
| "queryParameters": [], | ||
| "headers": [], | ||
| "generatedRequestName": "ListWidgetsRequest", | ||
| "response": { | ||
| "description": "Successful response", | ||
| "schema": { | ||
| "value": { | ||
| "generatedName": "ListWidgetsResponseItem", | ||
| "schema": "Widget", | ||
| "source": { | ||
| "file": "../core-api.yml", | ||
| "type": "openapi" | ||
| }, | ||
| "type": "reference" | ||
| }, | ||
| "generatedName": "ListWidgetsResponse", | ||
| "groupName": [], | ||
| "type": "array" | ||
| }, | ||
| "fullExamples": [], | ||
| "source": { | ||
| "file": "../core-api.yml", | ||
| "type": "openapi" | ||
| }, | ||
| "statusCode": 200, | ||
| "type": "json" | ||
| }, | ||
| "errors": {}, | ||
| "authed": false, | ||
| "method": "GET", | ||
| "path": "/widgets", | ||
| "examples": [ | ||
| { | ||
| "pathParameters": [], | ||
| "queryParameters": [], | ||
| "headers": [], | ||
| "response": { | ||
| "value": { | ||
| "value": [ | ||
| { | ||
| "properties": { | ||
| "id": { | ||
| "value": { | ||
| "value": "id", | ||
| "type": "string" | ||
| }, | ||
| "type": "primitive" | ||
| }, | ||
| "name": { | ||
| "value": { | ||
| "value": "name", | ||
| "type": "string" | ||
| }, | ||
| "type": "primitive" | ||
| } | ||
| }, | ||
| "type": "object" | ||
| } | ||
| ], | ||
| "type": "array" | ||
| }, | ||
| "type": "withoutStreaming" | ||
| }, | ||
| "codeSamples": [], | ||
| "type": "full" | ||
| } | ||
| ], | ||
| "source": { | ||
| "file": "../core-api.yml", | ||
| "type": "openapi" | ||
| }, | ||
| "__apiName": "api", | ||
| "servers": [ | ||
| { | ||
| "name": "api" | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "summary": "Issue a token", | ||
| "audiences": [], | ||
| "operationId": "issueToken", | ||
| "tags": [], | ||
| "pathParameters": [], | ||
| "queryParameters": [], | ||
| "headers": [], | ||
| "generatedRequestName": "IssueTokenRequest", | ||
| "request": { | ||
| "schema": { | ||
| "generatedName": "IssueTokenRequest", | ||
| "schema": "TokenRequest", | ||
| "source": { | ||
| "file": "../auth-api.yml", | ||
| "type": "openapi" | ||
| }, | ||
| "type": "reference" | ||
| }, | ||
| "contentType": "application/json", | ||
| "fullExamples": [], | ||
| "additionalProperties": false, | ||
| "source": { | ||
| "file": "../auth-api.yml", | ||
| "type": "openapi" | ||
| }, | ||
| "type": "json" | ||
| }, | ||
| "response": { | ||
| "description": "Successful response", | ||
| "schema": { | ||
| "generatedName": "IssueTokenResponse", | ||
| "schema": "TokenResponse", | ||
| "source": { | ||
| "file": "../auth-api.yml", | ||
| "type": "openapi" | ||
| }, | ||
| "type": "reference" | ||
| }, | ||
| "fullExamples": [], | ||
| "source": { | ||
| "file": "../auth-api.yml", | ||
| "type": "openapi" | ||
| }, | ||
| "statusCode": 200, | ||
| "type": "json" | ||
| }, | ||
| "errors": {}, | ||
| "authed": false, | ||
| "method": "POST", | ||
| "path": "/token", | ||
| "examples": [ | ||
| { | ||
| "pathParameters": [], | ||
| "queryParameters": [], | ||
| "headers": [], | ||
| "request": { | ||
| "properties": {}, | ||
| "type": "object" | ||
| }, | ||
| "response": { | ||
| "value": { | ||
| "properties": { | ||
| "accessToken": { | ||
| "value": { | ||
| "value": "accessToken", | ||
| "type": "string" | ||
| }, | ||
| "type": "primitive" | ||
| } | ||
| }, | ||
| "type": "object" | ||
| }, | ||
| "type": "withoutStreaming" | ||
| }, | ||
| "codeSamples": [], | ||
| "type": "full" | ||
| } | ||
| ], | ||
| "source": { | ||
| "file": "../auth-api.yml", | ||
| "type": "openapi" | ||
| }, | ||
| "__apiName": "auth", | ||
| "servers": [ | ||
| { | ||
| "name": "auth" | ||
| } | ||
| ] | ||
| } | ||
| ], | ||
| "webhooks": [], | ||
| "channels": {}, | ||
| "groupedSchemas": { | ||
| "rootSchemas": { | ||
| "Widget": { | ||
| "allOf": [], | ||
| "properties": [ | ||
| { | ||
| "conflict": {}, | ||
| "generatedName": "widgetId", | ||
| "key": "id", | ||
| "schema": { | ||
| "generatedName": "WidgetId", | ||
| "value": { | ||
| "schema": { | ||
| "type": "string" | ||
| }, | ||
| "generatedName": "WidgetId", | ||
| "groupName": [], | ||
| "type": "primitive" | ||
| }, | ||
| "groupName": [], | ||
| "type": "optional" | ||
| }, | ||
| "audiences": [] | ||
| }, | ||
| { | ||
| "conflict": {}, | ||
| "generatedName": "widgetName", | ||
| "key": "name", | ||
| "schema": { | ||
| "generatedName": "WidgetName", | ||
| "value": { | ||
| "schema": { | ||
| "type": "string" | ||
| }, | ||
| "generatedName": "WidgetName", | ||
| "groupName": [], | ||
| "type": "primitive" | ||
| }, | ||
| "groupName": [], | ||
| "type": "optional" | ||
| }, | ||
| "audiences": [] | ||
| } | ||
| ], | ||
| "allOfPropertyConflicts": [], | ||
| "generatedName": "Widget", | ||
| "groupName": [], | ||
| "additionalProperties": false, | ||
| "source": { | ||
| "file": "../core-api.yml", | ||
| "type": "openapi" | ||
| }, | ||
| "type": "object" | ||
| }, | ||
| "TokenRequest": { | ||
| "allOf": [], | ||
| "properties": [ | ||
| { | ||
| "conflict": {}, | ||
| "generatedName": "tokenRequestClientId", | ||
| "key": "clientId", | ||
| "schema": { | ||
| "generatedName": "TokenRequestClientId", | ||
| "value": { | ||
| "schema": { | ||
| "type": "string" | ||
| }, | ||
| "generatedName": "TokenRequestClientId", | ||
| "groupName": [], | ||
| "type": "primitive" | ||
| }, | ||
| "groupName": [], | ||
| "type": "optional" | ||
| }, | ||
| "audiences": [] | ||
| }, | ||
| { | ||
| "conflict": {}, | ||
| "generatedName": "tokenRequestClientSecret", | ||
| "key": "clientSecret", | ||
| "schema": { | ||
| "generatedName": "TokenRequestClientSecret", | ||
| "value": { | ||
| "schema": { | ||
| "type": "string" | ||
| }, | ||
| "generatedName": "TokenRequestClientSecret", | ||
| "groupName": [], | ||
| "type": "primitive" | ||
| }, | ||
| "groupName": [], | ||
| "type": "optional" | ||
| }, | ||
| "audiences": [] | ||
| } | ||
| ], | ||
| "allOfPropertyConflicts": [], | ||
| "generatedName": "TokenRequest", | ||
| "groupName": [], | ||
| "additionalProperties": false, | ||
| "source": { | ||
| "file": "../auth-api.yml", | ||
| "type": "openapi" | ||
| }, | ||
| "type": "object" | ||
| }, | ||
| "TokenResponse": { | ||
| "allOf": [], | ||
| "properties": [ | ||
| { | ||
| "conflict": {}, | ||
| "generatedName": "tokenResponseAccessToken", | ||
| "key": "accessToken", | ||
| "schema": { | ||
| "generatedName": "TokenResponseAccessToken", | ||
| "value": { | ||
| "schema": { | ||
| "type": "string" | ||
| }, | ||
| "generatedName": "TokenResponseAccessToken", | ||
| "groupName": [], | ||
| "type": "primitive" | ||
| }, | ||
| "groupName": [], | ||
| "type": "optional" | ||
| }, | ||
| "audiences": [] | ||
| } | ||
| ], | ||
| "allOfPropertyConflicts": [], | ||
| "generatedName": "TokenResponse", | ||
| "groupName": [], | ||
| "additionalProperties": false, | ||
| "source": { | ||
| "file": "../auth-api.yml", | ||
| "type": "openapi" | ||
| }, | ||
| "type": "object" | ||
| } | ||
| }, | ||
| "namespacedSchemas": {} | ||
| }, | ||
| "variables": {}, | ||
| "nonRequestReferencedSchemas": {}, | ||
| "securitySchemes": {}, | ||
| "globalHeaders": [], | ||
| "idempotencyHeaders": [], | ||
| "groups": {} | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🟡 warning
This flips precedence for all specs, not just broken ones: any workspace where a server has both a
descriptionand aname/x-fern-server-namewill now get a different environment key (e.g.CoreUnifiedApi→Production), which is a rename in the generated SDK's environment enum. That's the desired outcome here, but it's technically breaking for existing users relying on the description-derived name. Consider calling this out explicitly in the changelog entry ("environment names may change if...") so downstream consumers aren't surprised by afix-level bump.