api-ref: The endpoint of Pull PTP status notifications API is wrong

Bug #1970246 reported by Douglas Henrique Koerich
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
StarlingX
Fix Released
Low
Douglas Henrique Koerich

Bug Description

Brief Description
-----------------
The document of "PTP status notification API definition v1" has a typo. It should have "v1" in the endpoint.

https://docs.starlingx.io/api-ref/ptp-notification-armada-app/api_ptp_notifications_definition_v1.html?expanded=send-ptp-status-notifications-to-the-application-subscribed-detail#pull-ptp-status-notifications

Severity
--------
Major

Steps to Reproduce
------------------
Try to pull PTP current state using the given endpoint.

Expected Behavior
------------------
Accessing the endpoint returns correct information.

Actual Behavior
----------------
It returns the 404 (Not Found) error.

Reproducibility
---------------
Reproducible

System Configuration
--------------------
Any

Branch/Pull Time/Commit
-----------------------
r/stx6.0

Last Pass
---------
N/A

Timestamp/Logs
--------------
N/A

Test Activity
-------------
Feature Testing

Workaround
----------
Inserting "v1" in endpoint solves the problem.

Changed in starlingx:
assignee: nobody → Douglas Henrique Koerich (dkoerich-wr)
status: New → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to ptp-notification-armada-app (master)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to ptp-notification-armada-app (master)

Reviewed: https://review.opendev.org/c/starlingx/ptp-notification-armada-app/+/839245
Committed: https://opendev.org/starlingx/ptp-notification-armada-app/commit/7a6f1407057ffdb9a51eff7de91ebf5fb30d90f8
Submitter: "Zuul (22348)"
Branch: master

commit 7a6f1407057ffdb9a51eff7de91ebf5fb30d90f8
Author: Douglas Henrique Koerich <email address hidden>
Date: Mon Apr 25 14:04:17 2022 -0300

    Fix endpoint for pulling PTP current state

    This is a trivial change to fix the missing reference to "v1" in the
    endpoint URI for retrieving the PTP current state as contained in
    StarlingX documentation page.

    Test Plan:

    PASS: Checked updated page generated by Zuul.

    Closes-Bug: #1970246
    Signed-off-by: Douglas Henrique Koerich <email address hidden>
    Change-Id: Iabeee327d5badbb6feb6a3f51bcbb2cfa0fcb63b

Changed in starlingx:
status: In Progress → Fix Released
Ghada Khalil (gkhalil)
Changed in starlingx:
importance: Undecided → Low
tags: added: stx.7.0 stx.networking
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.