Skip to content

Commit

Permalink
Revert "Revert "chore: modify fdr apis to accomodate openapi parser f…
Browse files Browse the repository at this point in the history
…or docs generation"" (#1914)
  • Loading branch information
RohinBhargava authored Dec 19, 2024
1 parent ece9ae7 commit 6479103
Show file tree
Hide file tree
Showing 55 changed files with 1,145 additions and 152 deletions.
19 changes: 19 additions & 0 deletions fern/apis/fdr/definition/api/latest/__package__.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,21 @@ imports:
rootCommons: ../../commons.yml
auth: auth.yml

service:
base-path: /registry/api/latest
auth: true
audiences:
- read
endpoints:
getApiLatest:
method: GET
path: /load/{apiDefinitionId}
path-parameters:
apiDefinitionId: rootCommons.ApiDefinitionId
response: ApiDefinition
errors:
- ApiDoesNotExistError

types:
ApiDefinition:
properties:
Expand All @@ -20,3 +35,7 @@ types:
subpackages: map<commons.SubpackageId, commons.SubpackageMetadata>
auths: map<auth.AuthSchemeId, auth.AuthScheme>
globalHeaders: optional<list<type.ObjectProperty>>

errors:
ApiDoesNotExistError:
status-code: 404
4 changes: 3 additions & 1 deletion fern/apis/fdr/definition/api/v1/register/__package__.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ imports:
type: type.yml
rootCommons: ../../../commons.yml
commons: ../commons.yml
latest: ../../latest/__package__.yml
webhook: webhook.yml
websocket: websocket.yml

Expand All @@ -23,7 +24,8 @@ service:
properties:
orgId: rootCommons.OrgId
apiId: rootCommons.ApiId
definition: ApiDefinition
definition: optional<ApiDefinition>
definitionV2: optional<latest.ApiDefinition>
sources: optional<map<SourceId, Source>>
response: RegisterApiDefinitionResponse
errors:
Expand Down
2 changes: 2 additions & 0 deletions fern/apis/fdr/definition/docs/v1/read/__package__.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ imports:
algolia: ../../../algolia.yml
rootCommons: ../../../commons.yml
apiReadV1: ../../../api/v1/read/__package__.yml
apiReadLatest: ../../../api/latest/__package__.yml
apiCommonsV1: ../../../api/v1/commons.yml
commons: ../commons/commons.yml
navigationV1: ../../../navigation/v1/__package__.yml
Expand Down Expand Up @@ -67,6 +68,7 @@ types:
algoliaSearchIndex: optional<algolia.AlgoliaSearchIndex>
pages: map<rootCommons.PageId, PageContent>
apis: map<rootCommons.ApiDefinitionId, apiReadV1.ApiDefinition>
apisV2: map<rootCommons.ApiDefinitionId, apiReadLatest.ApiDefinition>
files: map<rootCommons.FileId, rootCommons.Url>
filesV2: map<rootCommons.FileId, File>
jsFiles:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ export class DefinitionObjectFactory {
return {
pages: {},
apis: {},
apisV2: {},
files: {},
filesV2: {},
config: {
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 6479103

Please sign in to comment.