IP Library Granted Patent US 10,761,838
Granted Patent B2
US 10,761,838 · App. 16/051,164 · Granted Sep 1, 2020

Generating unified and dynamically updatable application programming interface documentation from different sources

Inventors: Mainak Roy (Bangalore, IN); Chitrak Gupta (Bangalore, IN); Abhirup Seal (Kolkatta, IN)
Assignee: Dell Products L.P.
G06F8/73G06F16/313G06F16/3334G06F16/3338G06F16/38G06F16/93
View Patent ↗
Loading inventors, assignments & file history…
Monitor This Case
Get email alerts when status or documents change.
Order Certified Copies
Most orders are placed with the USPTO same day — all within 24 business hours.
Order via The Patent Place →
Pre-filled with this patent's details
Quick Facts
Patent No.
US 10,761,838
App. No.
16/051,164
Granted
Sep 1, 2020
Kind
B2
Abstract

A method in one embodiment comprises generating a document corpus comprising a plurality of application programming interface electronic documents, wherein the plurality of application programming interface electronic documents are organized according to one or more application programming interface versions, receiving a query from one or more users seeking information corresponding to one or more application programming interfaces, generating a subset of the plurality of application programming interface electronic documents from the database in response to the query using one or more code artifacts, retrieving data corresponding to the one or more application programming interface versions, dynamically modifying one or more of the plurality of application programming interface electronic documents in the subset of the plurality of application programming interface electronic documents based on the retrieved application programming interface version data, and transmitting the subset of the plurality of application programming interface electronic documents to the one or more users.

Claims (41)

1. An apparatus comprising:

at least one processing platform comprising a plurality of processing devices;

said at least one processing platform being configured to:

generate a document corpus comprising a plurality of application programming interface electronic documents, wherein the plurality of application programming interface electronic documents are organized according to one or more application programming interface versions;

receive a query from one or more users seeking information corresponding to one or more application programming interfaces;

generate a subset of the plurality of application programming interface electronic documents in response to the query using one or more code artifacts;

retrieve data corresponding to the one or more application programming interface versions;

dynamically modify one or more of the plurality of application programming interface electronic documents in the subset of the plurality of application programming interface electronic documents based on the retrieved application programming interface version data; and

transmit the subset of the plurality of application programming interface electronic documents to the one or more users in response to the query.

2. The apparatus of claim 1 wherein said at least one processing platform is further configured to transform the subset of the plurality of application programming interface electronic documents from one or more document formats into one or more supported document formats.

3. The apparatus of claim 2 wherein said at least one processing platform is further configured to format the query based on the one or more supported document formats.

4. The apparatus of claim 1 wherein said at least one processing platform is further configured to create a flag in connection with the query so that the subset of the plurality of application programming interface electronic documents illustrates differences between at least two of the application programming interface versions.

5. The apparatus of claim 1 wherein the retrieved application programming interface version data comprises at least one of error messages and supported attributes relevant to at least one of the application programming interface versions.

6. The apparatus of claim 1 wherein the code artifacts comprise at least one of managed object format (MOF) and management information base (MIB) code artifacts.

7. The apparatus of claim 1 wherein, in dynamically modifying the one or more of the plurality of application programming interface electronic documents in the subset, said at least one processing platform is further configured to at least one of create, update and delete one or more table entries in one or more databases specific to one or more interfaces.

8. The apparatus of claim 1 wherein said at least one processing platform is further configured to perform indexing of the document corpus, and to compute a term-document matrix from the index.

9. The apparatus of claim 1 wherein said at least one processing platform is further configured to compute highly correlated terms of the electronic documents in the document corpus.

10. The apparatus of claim 9 wherein said at least one processing platform is further configured to expand the query using the highly correlated terms.

11. The apparatus of claim 1 wherein said at least one processing platform is further configured to employ an automatic query expansion algorithm to expand the query.

12. The apparatus of claim 1 wherein said at least one processing platform is further configured to employ a ranking algorithm which ranks electronic documents of the plurality of application programming interface electronic documents corresponding to a later date higher than electronic documents of the plurality of application programming interface electronic documents corresponding to an earlier date.

13. A method comprising:

generating a document corpus comprising a plurality of application programming interface electronic documents, wherein the plurality of application programming interface electronic documents are organized according to one or more application programming interface versions;

receiving a query from one or more users seeking information corresponding to one or more application programming interfaces;

generating a subset of the plurality of application programming interface electronic documents from the database in response to the query using one or more code artifacts;

retrieving data corresponding to the one or more application programming interface versions;

dynamically modifying one or more of the plurality of application programming interface electronic documents in the subset of the plurality of application programming interface electronic documents based on the retrieved application programming interface version data; and

transmitting the subset of the plurality of application programming interface electronic documents to the one or more users in response to the query;

wherein the method is performed by at least one processing platform comprising at least one processing device comprising a processor coupled to a memory.

14. The method of claim 13 further comprising transforming the subset of the plurality of application programming interface electronic documents from one document format into one or more supported document formats.

15. The method of claim 14 further comprising formatting the query based on the one or more supported document formats.

16. The method of claim 13 further comprising creating a flag in connection with the query so that the subset of the plurality of application programming interface electronic documents illustrates differences between at least two of the application programming interface versions.

17. The method of claim 13 wherein the retrieved application programming interface version data comprises at least one of error messages and supported attributes relevant to at least one of the application programming interface versions.

18. The method of claim 13 wherein the code artifacts comprise at least one of managed object format (MOF) and management information base (MIB) code artifacts.

19. The method of claim 13 wherein dynamically modifying the one or more of the plurality of application programming interface electronic documents in the subset comprises at least one of creating, updating and deleting one or more table entries in one or more databases specific to one or more interfaces.

20. A computer program product comprising a non-transitory processor-readable storage medium having stored therein program code of one or more software programs, wherein the program code when executed by at least one processing platform causes said at least one processing platform to:

generate a document corpus comprising a plurality of application programming interface electronic documents, wherein the plurality of application programming interface electronic documents are organized according to one or more application programming interface versions;

receive a query from one or more users seeking information corresponding to one or more application programming interfaces;

generate a subset of the plurality of application programming interface electronic documents in response to the query using one or more code artifacts;

retrieve data corresponding to the one or more application programming interface versions;

dynamically modify one or more of the plurality of application programming interface electronic documents in the subset of the plurality of application programming interface electronic documents based on the retrieved application programming interface version data; and

transmit the subset of the plurality of application programming interface electronic documents to the one or more users in response to the query.

Assignments (8)
RELEASE OF SECURITY INTEREST IN PATENTS PREVIOUSLY RECORDED AT REEL/FRAME (053546/0001) Recorded Jun 23, 2022
From: THE BANK OF NEW YORK MELLON TRUST COMPANY, N.A., AS NOTES COLLATERAL AGENT
To: DELL MARKETING L.P. (ON BEHALF OF ITSELF AND AS SUCCESSOR-IN-INTEREST TO CREDANT TECHNOLOGIES, INC.); DELL INTERNATIONAL L.L.C.; DELL PRODUCTS L.P.; DELL USA L.P.; EMC CORPORATION; DELL MARKETING CORPORATION (SUCCESSOR-IN-INTEREST TO FORCE10 NETWORKS, INC. AND WYSE TECHNOLOGY L.L.C.); EMC IP HOLDING COMPANY LLC
Reel/Frame 071642/0001 →
RELEASE OF SECURITY INTEREST IN PATENTS PREVIOUSLY RECORDED AT REEL/FRAME (047648/0422) Recorded May 20, 2022
From: THE BANK OF NEW YORK MELLON TRUST COMPANY, N.A., AS NOTES COLLATERAL AGENT
To: DELL PRODUCTS L.P.; EMC CORPORATION; EMC IP HOLDING COMPANY LLC
Reel/Frame 060160/0862 →
RELEASE OF SECURITY INTEREST AT REEL 047648 FRAME 0346 Recorded Nov 2, 2021
From: CREDIT SUISSE AG, CAYMAN ISLANDS BRANCH
To: DELL PRODUCTS L.P.; EMC CORPORATION; EMC IP HOLDING COMPANY LLC
Reel/Frame 058298/0510 →
SECURITY AGREEMENT Recorded Apr 22, 2020
From: CREDANT TECHNOLOGIES INC.; DELL INTERNATIONAL L.L.C.; DELL MARKETING L.P.; DELL PRODUCTS L.P.; DELL USA L.P.; EMC CORPORATION; FORCE10 NETWORKS, INC.; WYSE TECHNOLOGY L.L.C.; EMC IP HOLDING COMPANY LLC
To: THE BANK OF NEW YORK MELLON TRUST COMPANY, N.A.
Reel/Frame 053546/0001 →
SECURITY AGREEMENT Recorded Mar 21, 2019
From: CREDANT TECHNOLOGIES, INC.; DELL INTERNATIONAL L.L.C.; DELL MARKETING L.P.; DELL PRODUCTS L.P.; DELL USA L.P.; EMC CORPORATION; FORCE10 NETWORKS, INC.; WYSE TECHNOLOGY L.L.C.; EMC IP HOLDING COMPANY LLC
To: THE BANK OF NEW YORK MELLON TRUST COMPANY, N.A.
Reel/Frame 049452/0223 →
PATENT SECURITY AGREEMENT (CREDIT) Recorded Oct 12, 2018
From: DELL PRODUCTS L.P.; EMC CORPORATION; EMC IP HOLDING COMPANY LLC
To: CREDIT SUISSE AG, CAYMAN ISLANDS BRANCH, AS COLLATERAL AGENT
Reel/Frame 047648/0346 →
PATENT SECURITY AGREEMENT (NOTES) Recorded Oct 12, 2018
From: DELL PRODUCTS L.P.; EMC CORPORATION; EMC IP HOLDING COMPANY LLC
To: THE BANK OF NEW YORK MELLON TRUST COMPANY, N.A., AS COLLATERAL AGENT
Reel/Frame 047648/0422 →
ASSIGNMENT OF ASSIGNOR'S INTEREST Recorded Jul 31, 2018
From: ROY, MAINAK; GUPTA, CHITRAK; SEAL, ABHIRUP
To: DELL PRODUCTS L.P.
Reel/Frame 046517/0394 →
Continuity (1)
Related Publication 20200042316A1 · Feb 6, 2020
Cited By (2)
US 12,417,135 US 12,474,904