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

Update location-verification-API-Readiness-Checklist.md #248

Merged
merged 4 commits into from
Aug 30, 2024

Conversation

jlurien
Copy link
Collaborator

@jlurien jlurien commented Aug 20, 2024

What type of PR is this?

  • documentation

What this PR does / why we need it:

User Story for location-verification is now available

Copy link

github-actions bot commented Aug 20, 2024

🦙 MegaLinter status: ✅ SUCCESS

Descriptor Linter Files Fixed Errors Elapsed time
✅ ACTION actionlint 2 0 0.02s
✅ OPENAPI spectral 3 0 4.94s
✅ REPOSITORY git_diff yes no 0.01s
✅ REPOSITORY secretlint yes no 0.83s
✅ YAML yamllint 3 0 0.74s

See detailed report in MegaLinter reports

MegaLinter is graciously provided by OX Security

bigludo7
bigludo7 previously approved these changes Aug 20, 2024
Copy link
Collaborator

@bigludo7 bigludo7 left a comment

Choose a reason for hiding this comment

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

LGTM.

@hdamker
Copy link
Contributor

hdamker commented Aug 20, 2024

The PR is correct, but is there a specific reason that the user story is in Supporting Documents and not in API Documentation as with other APIs? But guess that doesn't matter too much.

@jlurien
Copy link
Collaborator Author

jlurien commented Aug 22, 2024

The PR is correct, but is there a specific reason that the user story is in Supporting Documents and not in API Documentation as with other APIs? But guess that doesn't matter too much.

I guess no particular reason. should it be moved to API Doc?

@jlurien
Copy link
Collaborator Author

jlurien commented Aug 23, 2024

User Story moved

@jlurien jlurien requested a review from bigludo7 August 23, 2024 08:47
maxl2287
maxl2287 previously approved these changes Aug 23, 2024
bigludo7
bigludo7 previously approved these changes Aug 23, 2024
Copy link
Collaborator

@bigludo7 bigludo7 left a comment

Choose a reason for hiding this comment

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

LGTM

@jlurien
Copy link
Collaborator Author

jlurien commented Aug 23, 2024

@hdamker for

| 9 | Test result statement | O | O | O | M |tbd| link |

Do you know what is expected? Do we have any example from other APIs? Thanks

@bigludo7
Copy link
Collaborator

@hdamker for

| 9 | Test result statement | O | O | O | M |tbd| link |

Do you know what is expected? Do we have any example from other APIs? Thanks

I had same issue in OTP validation API. I've pinged @trehman-gsma for help - having a statement from GSMA that at least one implem has go thru the test could perhaps be an option?

@hdamker
Copy link
Contributor

hdamker commented Aug 23, 2024

Do you know what is expected? Do we have any example from other APIs? Thanks

I'm not aware of an example that any of the APIs has achieved this line within this release cycle. Suppose we accept this in the TSC for this cycle and have also to define this criteria more precise.

How it is described:

A statement in a discussion issue of the API Sub Project by at least one of the API Sub Project members that the Gherkin feature files have been successfully executed against their (lab) API implementation.

So not an implementation of a previous public version (which GSMA can have certified), but a (lab) implementation of the release candidate version from M3 with the test definition from the same version. The motivation was to reduce the risk that bugs in the API specification and inconsistencies between API and Test specification will be found only after the public release.

But as the release candidates came late and the test definitions in many cases even later, there was no time to fulfil this criteria in the current cycle.

@jlurien
Copy link
Collaborator Author

jlurien commented Aug 26, 2024

I agree that is going to be hard to fully comply with this for this meta, due to the time constraints.

@jlurien jlurien added the Fall24 Meta-release Fall24 label Aug 27, 2024
@jlurien
Copy link
Collaborator Author

jlurien commented Aug 28, 2024

@hdamker @bigludo7 how should we proceed with the PR regarding "Test result statement"? Do we open an issue in RM? Do we keep "tbd" in the meantime?

@hdamker
Copy link
Contributor

hdamker commented Aug 28, 2024

@hdamker @bigludo7 how should we proceed with the PR regarding "Test result statement"? Do we open an issue in RM? Do we keep "tbd" in the meantime?

Issue in RM to make them (and the TSC) aware makes sense for to me. The other APIs heading for stable have reported "N" as status, which is maybe more true, as there is no plan to get it done before the meta release.

@jlurien
Copy link
Collaborator Author

jlurien commented Aug 29, 2024

Created issue in RM: camaraproject/ReleaseManagement#89

@jlurien jlurien dismissed stale reviews from bigludo7 and maxl2287 via c328874 August 29, 2024 11:24
@jlurien
Copy link
Collaborator Author

jlurien commented Aug 29, 2024

Until a final resolution to the issue I have filled the row with "N" and a reference to the issue in the comments column

@jlurien jlurien requested a review from bigludo7 August 30, 2024 09:18
@jlurien jlurien requested a review from maxl2287 August 30, 2024 09:18
@jlurien
Copy link
Collaborator Author

jlurien commented Aug 30, 2024

@bigludo7 @maxl2287 please approve so I can merge

Copy link
Collaborator

@bigludo7 bigludo7 left a comment

Choose a reason for hiding this comment

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

LGTM

@jlurien jlurien merged commit 5ddf1db into main Aug 30, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Fall24 Meta-release Fall24
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants