Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

proposal on how to store more info in the openapi.json #13

Merged
merged 4 commits into from
Nov 21, 2023

Conversation

Matsemann
Copy link
Collaborator

@Matsemann Matsemann commented Nov 17, 2023

I just typed this change out here in github, not spending too much time on it if it's not popular ;)

Idea is to generate openapi.json on the form of

        "/api/v1/picking_oee/{some_id}/tasks/some-action/": {
            "put": {
                "operationId": "some-action",
                "description": "...",
                "tags": [
                    "picking"
                ],
                "x-reverse-path": "api:picking_oee:some-action", <----==== the new thingy

so that I in some other generator-code later can see that this is actually not just the picking module (which the tag is), but the specific sub-module in the reverse-path, with arbitrary many levels of something:something:something

Copy link
Contributor

@danielkjellid danielkjellid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me! The key is also clear and representative in terms of the data it holds, but let's get Sigurd's opinion on it as well.

Copy link
Contributor

@ljodal ljodal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👌

@Matsemann Matsemann merged commit 1028513 into main Nov 21, 2023
9 checks passed
@Matsemann Matsemann deleted the matsemann/x-path branch November 21, 2023 10:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants