feat(api): added openapi endpoints #1422
Merged
Conversation
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
github-actions
bot
added
the
t-core-services
jirimoravcik
approved these changes
Jan 22, 2025
Member
jirimoravcik
left a comment
jirimoravcik
left a comment
There was a problem hiding this comment.
Didn't we also add an endpoint for default build? Is it going to be added in another PR?
B4nan
reviewed
Jan 22, 2025
Contributor
Author
I'll add it in another PR |
TC-MO
requested changes
Jan 22, 2025
Contributor
TC-MO
left a comment
TC-MO
left a comment
There was a problem hiding this comment.
I've rewritten the descriptions slightly to address few things
- Actor capitalization
- Consistency
- Small descriptions to give more context instead just giving the note about similar endpoints
apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@openapi-specification.yaml
Outdated
Show resolved
Hide resolved
apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@openapi-specification.yaml
Outdated
Show resolved
Hide resolved
apify-api/openapi/paths/actors/acts@{actorId}@builds@{buildId}@openapi-specification.yaml
Outdated
Show resolved
Hide resolved
apify-api/openapi/paths/actor-builds/actor-builds@{buildId}@openapi-specification.yaml
Outdated
Show resolved
Hide resolved
danpoletaev
requested review from
B4nan and
TC-MO
and removed request for
B4nan
TC-MO
approved these changes
Jan 22, 2025
B4nan
approved these changes
Jan 22, 2025
| example: Your Magic Actor | ||
| version: | ||
| type: string | ||
| example: "1.0" |
Member
There was a problem hiding this comment.
the quoting is inconsistent here, lets use single quotes everywhere (there are more places using double quotes, not just in this file)
Contributor
Author
There was a problem hiding this comment.
Hm, fixed in the files I've changed, but it is harder to change everywhere else. I think it should be fixed in lint, but we'll need to set up yaml lint for that...
fnesveda
added
the
validated
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Recently, we introduced two new endpoints that return the OpenAPI specification:
/acts/<actorId>/builds/<buildId>/openapi-specification/actor-builds/<buildId>/openapi-specificationThis PR updates the documentation to include these endpoints.
@TC-MO Let me, please, know if you think we should add any additional information 🙏